home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 2.iso / dist / fw_hylafax.idb / usr / freeware / catman / u_man / cat1 / faxrm.Z / faxrm
Text File  |  2002-07-08  |  4KB  |  98 lines
  1. FAXRM(1)                         FAXRM(1)
  2.  
  3.  
  4.  
  5. NNAAMMEE
  6.        faxrm - remove a    _H_y_l_a_F_A_X    job or document    from a server
  7.  
  8. SSYYNNOOPPSSIISS
  9.        ffaaxxrrmm [ --aa ] [ --dd ] [ --vv    ] [ --hh _h_o_s_t_n_a_m_e    ] _i_d...
  10.  
  11. DDEESSCCRRIIPPTTIIOONN
  12.        _f_a_x_r_m removes one or more jobs or documents from    a _H_y_l_a_F_A_X
  13.        server.    If a job that is to be removed is being    processed
  14.        by a server, it is first    aborted.
  15.  
  16.        An  _i_d  is either a number that identifies a _j_o_b    (default)
  17.        or, if the --dd option is specified,  a  document    pathname.
  18.        Job  identifiers     are  printed by _s_e_n_d_f_a_x(1) when jobs are
  19.        queued for transmission;    they can also be  displayed  with
  20.        _f_a_x_s_t_a_t(1).   The  names    of documents associated    with out
  21.        bound jobs can be seen by supplying the --ff option to _f_a_x_s_
  22.        _t_a_t.   Documents     in  the receive queue can be viewed with
  23.        the --rr option to    _f_a_x_s_t_a_t.
  24.  
  25.        Unprivileged users can only remove jobs or documents  that
  26.        they  own.   Clients  with  administrative  privileges can
  27.        remove any job or document (see the --aa option below).
  28.  
  29. OOPPTTIIOONNSS
  30.        --aa     Use administrative privileges;    _f_a_x_r_m will prompt
  31.          for  the  password  to    set administrative privi
  32.          leges.
  33.  
  34.        --dd     Interpret each    _i_d as a    document pathname.  If    a
  35.          pathname  does     not  begin with ``/'' then _f_a_x_r_m
  36.          automatically prepends    ``/docq/''.
  37.  
  38.        --hh _h_o_s_t     Contact the server at the specified  _h_o_s_t.   The
  39.          _h_o_s_t  may be either a symbolic    name or    a network
  40.          address.  If no server    is specified then  If  no
  41.          --hh  option is supplied, _f_a_x_r_m uses the    FAXSERVER
  42.          environment variable  to  identify  the  _H_y_l_a_F_A_X
  43.          server    to contact.  If    this variable is not set,
  44.          then _f_a_x_r_m checks for a setting in the     configu
  45.          ration     files    (first    in  the    per-user file and
  46.          then in the system-wide file).     If  all  of  the
  47.          above    fails,    then  _f_a_x_r_m attempts to    contact    a
  48.          server    on the machine where it    is run.
  49.  
  50.        --vv     Trace the protocol  messages  to  and    from  the
  51.          server.
  52.  
  53. CCOONNFFIIGGUURRAATTIIOONN PPAARRAAMMEETTEERRSS
  54.        _f_a_x_r_m reads configuration information from the file $${{LLIIBB
  55.        DDAATTAA}}//hhyyllaa..ccoonnff and then    from the file ~~//..hhyyllaarrcc.  Config
  56.        uration files follow the    conventions described in _h_y_l_a_f_a_x_-
  57.        _c_l_i_e_n_t(1).  The    following  configuration  parameters  are
  58.        recognized:
  59.        TTaagg         TTyyppee        DDeeffaauulltt     DDeessccrriippttiioonn
  60.        Host         string        localhost     host to contact for service
  61.        Port         integer    4559     port to use in    contacting server
  62.        Protocol         string        tcp         protocol to use in contacting server
  63.        Verbose         boolean    No         whether or not    to enable protocol tracing
  64.  
  65.        The configuration parameters are    explained below:
  66.  
  67.        HHoosstt     The host to contact for service.  (Equivalent to
  68.          the --hh    option.)
  69.  
  70.        PPoorrtt     The  network  port  to     contact   for     service.
  71.          (Eqvuialent to    the --hh option.)
  72.  
  73.        PPrroottooccooll     The  name  of    the communication protocol to use
  74.          when contacting a server.   (Equivalent  to  the
  75.          FFAAXXSSEERRVVIICCEE environment    variable.)
  76.  
  77.        VVeerrbboossee     Control protocol tracing.  (Equivalent    to the --vv
  78.          option.)
  79.  
  80. DDIIAAGGNNOOSSTTIICCSS
  81.        JJoobb %%ss rreemmoovveedd..    A confirmation that the    job was     success
  82.        fully removed from the sseennddqq directory.
  83.  
  84.        JJoobb  %%ss rreemmoovveedd ((ffrroomm ddoonneeqq))..  A    confirmation that the job
  85.        was successfully    removed     from  the  ddoonnee  directory;  the
  86.        directory where jobs are    placed once they are finished.
  87.  
  88.        %%ss rreemmoovveedd..  A confirmation that    the document was success
  89.        fully deleted from the server.
  90.  
  91. SSEEEE AALLSSOO
  92.        _h_y_l_a_f_a_x_-_c_l_i_e_n_t(1),  _s_e_n_d_f_a_x(1),    _f_a_x_a_l_t_e_r(1),  _f_a_x_s_t_a_t(1),
  93.        _h_f_a_x_d(${MANNUM1_8})
  94.  
  95.  
  96.  
  97.                May 12, 1996             FAXRM(1)
  98.